feat(payment): improve create api docs #822
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fersilva16
requested review from
sibelius,
rturk,
daniloab,
edumaciel10,
noghartt,
samueldurantes and
Eckzzo
as code owners
Deploying with
|
| Latest commit: |
1fb8bdf
|
| Status: | ⚡️ Build in progress... |
daniloab
reviewed
Feb 7, 2024
| @@ -15,18 +15,20 @@ import TabItem from '@theme/TabItem'; | |||
| Nós disponibilizamos o _endpoint_ `/api/v1/payment` para que você possa criar | |||
| um novo _payment_ para a respectiva empresa afiliada. | |||
|
|
|||
| Você pode acessar [aqui](<[https://developers.openpix.com.br/api#tag/payment-(request-access)/paths/~1api~1v1~1payment/post](https://developers.openpix.com.br/api#tag/payment-(request-access)/paths/~1api~1v1~1payment/post)>) | |||
daniloab
reviewed
Feb 7, 2024
| @@ -3348,6 +3361,9 @@ components: | |||
| destinationAlias: | |||
| type: string | |||
| description: the pix key the payment should be sent to | |||
| destinationAliasType: | |||
| type: string | |||
| description: the type of the pix key the payment should be sent to | |||
There was a problem hiding this comment.
can we have each type here?
daniloab
reviewed
Feb 7, 2024
| 2. Por QR Code, esperamos o envio obrigatório dos itens `qrCode` e `correlationID`. | ||
|
|
||
| Abaixo temos a descrição de cada campo junto dos opcionais: | ||
|
|
||
| - **`value`**: O valor em centavos do pagamento a ser criado. | ||
| - **`destinationAlias`**: A chave pix destinatária do pagamento criado. | ||
| - **`destinationAliasType`**: A tipo da chave pix destinatária do pagamento criado. |
There was a problem hiding this comment.
can we have each type of pix key here?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.